/*
 * JBoss, Home of Professional Open Source
 * Copyright 2011, Red Hat, Inc. and individual contributors
 * by the @authors tag. See the copyright.txt in the distribution for a
 * full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package net.java.slee.resource.http;

import javax.servlet.http.HttpSession;
import javax.slee.SLEEException;
import javax.slee.resource.ActivityAlreadyExistsException;
import javax.slee.resource.StartActivityException;

/**
 * 
 * Provides SBB with an interface
 * 
 * @author Ivelin Ivanov
 * @version 1.0
 * 
 */
public interface HttpServletRaSbbInterface {

	/**
	 * Retrieves an {@link HttpSessionActivity} for the specified
	 * {@link HttpSession}. If the activity does not exist a new one is created.
	 * 
	 * @param httpSession
	 * @return
	 * @throws NullPointerException
	 * @throws IllegalArgumentException if the http session instance class is not recognizable
	 * @throws IllegalStateException
	 * @throws ActivityAlreadyExistsException
	 * @throws StartActivityException
	 * @throws SLEEException
	 */
	public HttpSessionActivity getHttpSessionActivity(HttpSession httpSession)
			throws  NullPointerException, IllegalArgumentException, IllegalStateException,
			ActivityAlreadyExistsException, StartActivityException,
			SLEEException;

}
